home *** CD-ROM | disk | FTP | other *** search
/ The Utilities Experience / The Utilities Experience - Volume 1.iso / software / misc / o-z / x-windows / mesa-amiwin / include / gl / osmesa.h < prev    next >
Encoding:
C/C++ Source or Header  |  1995-10-12  |  4.1 KB  |  137 lines
  1. /* $Id: osmesa.h,v 1.1 1995/10/12 16:44:12 brianp Exp $ */
  2.  
  3. /*
  4.  * Mesa 3-D graphics library
  5.  * Version:  1.2
  6.  * Copyright (C) 1995  Brian Paul  (brianp@ssec.wisc.edu)
  7.  *
  8.  * This library is free software; you can redistribute it and/or
  9.  * modify it under the terms of the GNU Library General Public
  10.  * License as published by the Free Software Foundation; either
  11.  * version 2 of the License, or (at your option) any later version.
  12.  *
  13.  * This library is distributed in the hope that it will be useful,
  14.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16.  * Library General Public License for more details.
  17.  *
  18.  * You should have received a copy of the GNU Library General Public
  19.  * License along with this library; if not, write to the Free
  20.  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21.  */
  22.  
  23.  
  24. /*
  25. $Log: osmesa.h,v $
  26.  * Revision 1.1  1995/10/12  16:44:12  brianp
  27.  * Initial revision
  28.  *
  29.  */
  30.  
  31.  
  32. /*
  33.  * Mesa Off-Screen rendering interface.
  34.  *
  35.  * This is an operating system and window system independent interface to
  36.  * Mesa which allows one to render images into a client-supplied buffer in
  37.  * main memory.  Such images may manipulated or saved in whatever way the
  38.  * client wants.
  39.  *
  40.  * There are only three API functions:
  41.  *   1. OSMesaCreateContext - create a new Off-Screen Mesa rendering context
  42.  *   2. OSMesaMakeCurrent - bind an OSMesaContext to a client's image buffer
  43.  *                          and make the specified context the current one.
  44.  *   3. OSMesaDestroyContext - destroy an OSMesaContext
  45.  *
  46.  *
  47.  * The limits on the width and height of an image buffer are MAX_WIDTH and
  48.  * MAX_HEIGHT as defined in Mesa/src/config.h.  Defaults are 1280 and 1024.
  49.  * You can increase them as needed but beware that many temporary arrays in
  50.  * Mesa are dimensioned by MAX_WIDTH or MAX_WIDTH.
  51.  */
  52.  
  53.  
  54.  
  55. #ifndef OSMESA_H
  56. #define OSMESA_H
  57.  
  58.  
  59.  
  60. #ifdef __cplusplus
  61. extern "C" {
  62. #endif
  63.  
  64.  
  65. #include "GL/gl.h"
  66.  
  67.  
  68.  
  69. typedef struct osmesa_context *OSMesaContext;
  70.  
  71.  
  72.  
  73. /*
  74.  * Create an Off-Screen Mesa rendering context.  The only attribute needed is
  75.  * an RGBA vs Color-Index mode flag.
  76.  *
  77.  * Input:  format - either GL_RGBA or GL_COLOR_INDEX
  78.  *         sharelist - specifies another OSMesaContext with which to share
  79.  *                     display lists.  NULL indicates no sharing.
  80.  * Return:  an OSMesaContext or 0 if error
  81.  */
  82. extern OSMesaContext OSMesaCreateContext( GLenum format,
  83.                                           OSMesaContext sharelist );
  84.  
  85.  
  86.  
  87.  
  88. /*
  89.  * Destroy an Off-Screen Mesa rendering context.
  90.  *
  91.  * Input:  ctx - the context to destroy
  92.  */
  93. extern void OSMesaDestroyContext( OSMesaContext ctx );
  94.  
  95.  
  96.  
  97. /*
  98.  * Bind an OSMesaContext to an image buffer.  The image buffer is just a
  99.  * block of memory which the client provides.  Its size must be at least
  100.  * as large as width*height*sizeof(type).  Its address should be a multiple
  101.  * of 4 if using RGBA mode.
  102.  *
  103.  * Image data is stored in the order of glDrawPixels:  row-major order
  104.  * with the lower-left image pixel stored in the first array position
  105.  * (ie. bottom-to-top).
  106.  *
  107.  * Since the only type initially supported is GL_UNSIGNED_BYTE, if the
  108.  * context is in RGBA mode, each pixel will be stored as a 4-byte RGBA
  109.  * value.  If the context is in color indexed mode, each pixel will be
  110.  * stored as a 1-byte value.
  111.  *
  112.  * If the context's viewport hasn't been initialized yet, it will now be
  113.  * initialized to (0,0,width,height).
  114.  *
  115.  * Input:  ctx - the rendering context
  116.  *         buffer - the image buffer memory
  117.  *         type - data type for pixel components, only GL_UNSIGNED_BYTE
  118.  *                supported now
  119.  *         width, height - size of image buffer in pixels, at least 1
  120.  * Return:  GL_TRUE if success, GL_FALSE if error because of invalid ctx,
  121.  *          invalid buffer address, type!=GL_UNSIGNED_BYTE, width<1, height<1,
  122.  *          width>internal limit or height>internal limit.
  123.  */
  124. extern GLboolean OSMesaMakeCurrent( OSMesaContext ctx,
  125.                                     void *buffer, GLenum type,
  126.                                     GLsizei width, GLsizei height );
  127.  
  128.  
  129.  
  130.  
  131. #ifdef __cplusplus
  132. }
  133. #endif
  134.  
  135.  
  136. #endif
  137.